docs: improve README with links and updates #538
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Argo Rollouts also [uses this repo](https://github.com/argoproj/argo-rollouts/blob/db5e3b2a8ffd9aef8c1e2026985c906fc9eef068/ui/package.json#L11) - update Yarn link to Yarn v1 / Classic, as those docs are quite different from the current v4 docs - same for Storybook v6 vs current v7 / v8 beta - say "Storybook" with an in-line link, not just a link. it is referred to as "Storybook" - see also k8s style guide on [links](https://kubernetes.io/docs/contribute/style/style-guide/#links) - simplify "Build & Run" section a bit - changing dirs to the repo you just cloned is implied. we don't say how to clone or fork, so leave this out too - also you don't have to name your local dir `argo-ui` - "`yarn install` to install dependencies" is redundant - a bit simpler and more direct, [per k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - could make it even simpler, but left it close to the same style for now - fix some `markdownlint` etc issues in the "Local Development" section - specify syntax in code blocks - `yalc` should be in backticks as it's a command Signed-off-by: Anton Gilgur <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The README is a bit dated -- particularly in its links to deps -- and could use some improvements
Modifications
Argo Rollouts also uses this repo
update Yarn link to Yarn v1 / Classic, as those docs are quite different from the current v4 docs
same for Storybook v6 vs current v7 / v8 beta
simplify "Build & Run" section a bit
argo-uiyarn installto install dependencies" is redundantfix some
markdownlintetc issues in the "Local Development" sectionyalcshould be in backticks as it's a commandVerification
Docs-only change, see rendered version in this PR